Range
Function
This API is used to get parameter range for Storage > Schedules(cloud dedicated) > Capture page.
Note:
The Range provides reference information for client UI input limits and API request limits. When sending Get and Set requests, the parameters must be strictly limited according to the Range, otherwise the request may be rejected by the device.
Request Message
None.
Sample:
POST /API/Schedules/Capture/Range HTTP/1.1
{
"version": "1.0",
"data": {}
}
Response Message
Parameter Description
Table 1
| Parameter | Range | Type | Description |
|---|---|---|---|
| channel | CH1 CH1x IP_CH1 IP_CH1x WIFI_CH1 WIFI_CH1x The number of channels depends on the functionality of the device | string array | Each array bit represents a channel with a string |
| channel_info | JSON Object | Channel Info object,see Table 2 for detailed information | |
| channel_max | int | Total channel of the current device | |
| support_copy | bool | Page support copy (NVR, DVR dedicated) |
Table 2
Channel Info object
| Parameter | Range | Type | Description |
|---|---|---|---|
| CH1 | Json Object | Channel object,see Table 3 for detailed information | |
| WIFI_CH1 | Json Object |
Table 3
Channel object
| Parameter | Range | Type | Description |
|---|---|---|---|
| status | "Offline","Online"， “Nonsupport” | string | Channel online status, only for digital channels. Note: This field does not exist when the channel is online |
| copy_ch | "digit", "analog", "wifi", "local", "all" | string | Support channel replication logo (NVR, DVR special) |
| category | array | see Table 4 for detailed information |
Table 4
| Parameter | Range | Type | Description |
|---|---|---|---|
| schedule_type | "Normal","Motion","Io" | string | Supported schedule types |
| schedule_list | array | see Table 5 for detailed information |
Table 5
| Parameter | Range | Type | Description |
|---|---|---|---|
| enable | bool | Whether the schedule is enabled | |
| start_time | 0~1439 | int | start time |
| end_time | 0~1440 | int | end time |
| weekday | "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" | string | number of days |
Tips:
The response message of the Range request may not contain all the fields in the above table, and the fields not included indicate that the device does not support this parameter configuration.
Sample:
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": "success",
"data": {
"channel_max": 1,
"support_copy": true,
"channel_info": {
"type": "object",
"items": {"CH1": {
"type": "object",
"items": {
"status": {
"description": "Only offline channel has this variable.",
"type": "string",
"mode": "r",
"items": [
"Offline",
"Online"
]
},
"copy_ch": {
"type": "string",
"items": ["all"]
},
"category": {
"type": "array",
"min_size": 0,
"max_size": 5,
"items": [{
"schedule_type": {
"type": "string",
"items": [
"Normal",
"Motion"
]
},
"schedule_list": {
"type": "array",
"min_size": 0,
"max_size": 8,
"items": [{
"enable": {"type": "bool"},
"start_time": {
"type": "int32",
"min": 0,
"max": 1439
},
"end_time": {
"type": "int32",
"min": 0,
"max": 1440
},
"weekday": {
"type": "array",
"min_size": 1,
"max_size": 7,
"items": [{
"type": "string",
"items": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
}]
}
}]
}
}]
}
}
}}
}
}
}
Error Code
See Response Messages Body and Common error_code for more information.